home *** CD-ROM | disk | FTP | other *** search
/ Die Speccy' 97 / Die Speccy' 97.iso / amiga_system / the_aminet / comm / fido / ttrxid18.lha / TrapTrxID.english.doc < prev    next >
Text File  |  1994-09-01  |  12KB  |  322 lines
  1.  
  2.  
  3.                \\\\\\\\\\\\\\\\\\\\////////////////////
  4.                               TrapTrxID
  5.                                  v1.8
  6.                           Time Synchronizer
  7.  
  8.                              User Manual
  9.  
  10.                                   by
  11.                            Giuseppe Vicari
  12.                        2:331/106.1@Fidonet.Org
  13.                ////////////////////\\\\\\\\\\\\\\\\\\\\
  14.  
  15.  
  16.  
  17.  
  18. ****    Index                                                     Line
  19.  
  20.       . What is it?                                                 38
  21.       . What's this tool for?                                       46
  22.       . Why to use TrapTrxID?                                       55
  23.       . How to use?                                                 84
  24.       . Special notes about TrapDoor?                              155
  25.       . How does it work?                                          168
  26.       . Bugs and troubles?                                         194
  27.       . How to reach me in case of troubles?                       200
  28.       . History of TrapTrxID?                                      208
  29.       . How much is it?                                            278
  30.       . Who I'd like to thank?                                     297
  31.       . How to check out this is the original program?             311
  32.       . End of the document                                        321
  33.  
  34.  
  35. ****    End of the index
  36.  
  37.  
  38. >>>>    What is it?
  39.  
  40.     TrapTrxID is a tiny tool be used in conjunction with TrapDoor.  It
  41. allows  to  syncronize  the  system  clock  by  using  the information
  42. included in TrapDoor log file.  Such information is recorded during an
  43. EMSI connection to the node you want to synchronize with.
  44.  
  45.  
  46. >>>>    What's this tool for?
  47.  
  48.     Some  nodes  may  have  their  system  time  synchronized with the
  49. "famous"  atomic clocks (either by using special devices or connecting
  50. to  other  nodes).   In  this  way, you may have your clock set at the
  51. right  time.   How?   Connect to the node you want to synchronize with
  52. using TrapDoor, then run TrapTrxID and, automagically, you'll get it!
  53.  
  54.  
  55. >>>>    Why to use TrapTrxID?
  56.  
  57.     There  are  a  lot  of  interesting  features  that other existing
  58. programs do not offer, such as:
  59.  
  60.     1. It has been built to be the shortest and fastest program on the
  61.        earth ;-)
  62.  
  63.     2. Full  scanning  of the log file:  it avoids loosing data if the
  64.        last session had been very long.
  65.  
  66.     3. Optionally, it can scan only a part of the log file.
  67.  
  68.     4. It  tells  the  system  when  a  synchronization takes place by
  69.        writing a line in the TrapDoor log file.
  70.  
  71.     5. It  does  not repeat the synchronization if you run the program
  72.        several times and such a line exists in the log file.
  73.  
  74.     6. It can synchronize with more nodes in a single scanning.
  75.  
  76.     7. It can check the maximum value of time correction.
  77.  
  78.     8. It  can  synchronize  with  systems  standing in different time
  79.        zones
  80.  
  81.     9. It can synchronize the internal clock.
  82.  
  83.  
  84. >>>>    How to use?
  85.  
  86.     TrapTrxID requires KickStart v2.0+ (yet another good reason for an
  87. upgrading).
  88.  
  89.     TrapTrxID  can  be run either from CLI (from a script file such as
  90. User-StartUp  or  StartUp-Sequence) or just after an EMSI session.  In
  91. this  second way, a synchronization takes place at each session:  this
  92. can  be done using the TrapDoor AFTERSESSION option (look at documents
  93. that come along with the TrapDoor package).
  94.  
  95.     TrapTrxID takes seven arguments:
  96.  
  97. 1)  LOGNAME,  the  file  name  of  TrapDoor log file (add the path, if
  98.     necessary); you MUST supply this parameter.
  99.  
  100. 2)  NODE,  a  list of node numbers you want to synchronize with.  Each
  101.     element of such a list has the format <node>,<maxerr>,<ztime>:
  102.     <node>   - an AmigaDOS regular expression that identifies the node
  103.                you want to synchronize with;
  104.     <maxerr> - the  max difference of time between the two clocks.  If
  105.                such  a value is exceeded, the synchronization will not
  106.                be considered valid.  If this parameter is omitted or a
  107.                0  value  is  supplied  the synchronization will always
  108.                take place.
  109.     <ztime>  - the  difference of time zone between the remote and the
  110.                local   node.    This   parameter   is  in  the  format
  111.                <hours>:<minutes>   (e.g.    1:30  means  there'  is  a
  112.                difference  of 1 hour and 30 minutes between the remote
  113.                and  the  local node).  By default, the synchronization
  114.                is  with  the  last  node an EMSI connection took place
  115.                with.
  116.  
  117. 3)  The  NOUPDATE  flag,  if  you  don't  want TrapTrxID to update the
  118.     clock.  This is useful during tests or just to verify one's clock.
  119.  
  120. 4)  The ASK flag, if you want TrapTrxID to request confirmation before
  121.     setting the clock.
  122.  
  123. 5)  The SET flag, if you want to synchronize also the internal clock.
  124.  
  125. 6)  BUFFER,  the  size  of  the internal buffer in bytes.  The default
  126.     size is 8192, the minimum size is 256.  The bigger the buffer, the
  127.     faster  the  program  (expecially  if  the  log  file is on a slow
  128.     peripheral).
  129.  
  130. 7)  TAIL,  it  tells  TrapTrxID to scan the last part of the log file.
  131.     By default, it scans the whole file; this option allow to speed up
  132.     a  lot  the scan of the log file, but you should use it carefully,
  133.     otherwise  the synchronization may fail.  Suggested value is 10240
  134.     ( = 10Kbyte).
  135.  
  136.     Here is the command template:
  137.  
  138. LOGNAME/A,NODE/M,NOUPDATE/S,ASK/S,SET/S,BUFFER/N,TAIL/N
  139.  
  140.     Example (from CLI):
  141.  
  142. TrapTrxID Mail:Logs/TrapDoor.log 2:333/100.0
  143.  
  144.     Add  a  line  like  this  one  in  a  script file or use it to run
  145. TrapTrxID from the CLI.
  146.  
  147.     Example (from TrapDoor):
  148.  
  149. AFTERSESSION "TrapTrxID %l 2:333/100.0"
  150.  
  151.     Add a line like this one in TrapDoor configuration file.  TrapDoor
  152. will replace the string %l with the (full) name of the log file.
  153.  
  154.  
  155. >>>>    Special notes about TrapDoor?
  156.  
  157.     This  version  of  TrapDoor  was  developed using and referring to
  158. TrapDoor version 1.83.  Neverthless, previous releases of TrapDoor can
  159. do  as well, as long as they allow the reception of TrxID, Name or AKA
  160. messages  (examine  TrapDoor  documentation to find out wheter this is
  161. case fit to you or not).
  162.  
  163.     TrapDoor configuration file is something I really must talk about.
  164. In  order  to  let TrapTrxID to work properly, it is required a string
  165. LOGLEVEL 8:n (n>2) to appear in the file.
  166.  
  167.  
  168. >>>>    How does it work?
  169.  
  170.     TrapTrxID  search  in  the  log  file for lines like the following
  171. ones:
  172.  
  173. : 26-Dec-92 12:11:01   Name: Nome BBS (2:334/155.0)
  174. : 26-Dec-92 12:11:01    AKA: 2:23331/1.0 3:1/1.0
  175.  
  176. then  it compares the address given as argument with the ones in these
  177. lines.  If they match, it means that the next line of type
  178.  
  179. : 26-Dec-92 12:11:01  TrxID: 2b3c4bd0/2b3c4ad7
  180.  
  181. will  be  good to get the time difference between our system clock and
  182. the   remote   one:   it  evaluate  the  difference  between  the  two
  183. hexadecimal  parameters  on  the  line  just after the keyword TrxID:.
  184. Hence  it  gets the difference (in seconds) between the local node and
  185. the  remote  one.   Of course this operation concern the last session.
  186. After updating the clock, TrapTrxID add a line of kind
  187.  
  188. " 26-Dec-92 12:34:24  Adjusted by -4:09 [725371856] (3:1/1.0)
  189.  
  190. in  order  to  prevent TrapTrxID from re-updating the time until a new
  191. EMSI session takes place.
  192.  
  193.  
  194. >>>>    Bugs and troubles?
  195.  
  196.     No  known  bugs  exists  or,  at  least, they never showed up till
  197. today.
  198.  
  199.  
  200. >>>>    How to reach me in case of troubles?
  201.  
  202.     In  case  of  troubles  or bugs, you can reach me at the following
  203. e-mail address:
  204.  
  205.                Giuseppe Vicari 2:331/106.1@Fidonet.Org
  206.  
  207.  
  208. >>>>    History of TrapTrxID?
  209.  
  210.     . v1.8 1 Sep 94:
  211.  
  212.         Fixed a very insignificant bug and recompiled with GCC v2.6.0.
  213.  
  214.     . v1.7 20 Mar 94:
  215.  
  216.         Fixed a very insignificant bug.
  217.  
  218.     . v1.6 15 Mar 94:
  219.  
  220.         Revolution!
  221.     - multiple   nodes  accepted  (the  procedures  that  handles  the
  222.       synchronization has been changed);
  223.     - max synchronization error handling;
  224.     - time zone handling (see manual);
  225.     - TAIL option (see manual);
  226.     - it shows the new date after a synchronization;
  227.     - the  synchronization  time  is added (in square brackets) in the
  228.       "Adjusted by" line;
  229.     - handles nodes in 5D standard (es.  1:2/3.4@fidonet.org);
  230.     - optimized some procedures;
  231.     - I/O uses non-buffered functions;
  232.     - reduced the needed stack size;
  233.     - reduced the executable size of the 50.2% (-3548 bytes);
  234.     - increased  speed (on a 68000 Amiga, with a 1Mbyte log file and a
  235.       8Kbyte internal buffer it is 6 times faster!)
  236.     - TrapTrxID.guide now available.
  237.  
  238.         By  the  way,  TrapTrxID  is 100% compatible with the previous
  239.     release.
  240.  
  241.     . v1.5 1 Aug 93:
  242.  
  243.         Added the NOUPDATE flag (see manual)
  244.  
  245.     . v1.4 7 Apr 93:
  246.  
  247.         New   coding   using  the  typical  AmigaDOS  functions:   the
  248.     executable  code  got considerably shorter and more efficient; the
  249.     line   parser  is  AmigaDOS  compatible;  changed  the  text  line
  250.     TrapTrxID  writes  in the log file (it's still compatible with the
  251.     older  releases);  added  the BUFFER option; added the ASK and SET
  252.     flags; an english manual is now available.
  253.         Try "version TrapTrxID" ;-).
  254.  
  255.     . v1.3 31 Jan 93:
  256.  
  257.         Fixed  a bug that caused the computer to crash.  It was not my
  258.     fault, but compiler-optimizer's.
  259.  
  260.     . v1.2 30 Jan 93:
  261.  
  262.         Now  you can avoid specifying the name of the node you want to
  263.     perform  the  synchronization:   it  will  take  the last one.  If
  264.     TrapTrxID  runs from WorkBench, it opens a small window, shows the
  265.     syntax  and  closes  it  after  5  seconds.  Replaced the function
  266.     main() with the _main():  got a shorter code.
  267.  
  268.     . v1.1 22 Jan 93:
  269.  
  270.         Fixed  a  very  insignificant  bug, added an error message and
  271.     optimized some parts of the program.
  272.  
  273.     . v1.0 3 Jan 93
  274.  
  275.         First version.
  276.  
  277.  
  278. >>>>    How much is it?
  279.  
  280.     This  program  is  Freely Distributable and Usable.  Permission is
  281. given  to freely distibute this program provided no fee is charged and
  282. no  changes  or  modification of the code and of the documentation are
  283. made.   In  other  words,  this  is  a  FD (Freely Distributable).  Of
  284. course, I won't be disappointed if you send me any money donation $-).
  285. Furthermore,  I'd  like  get  a  nice  postcard  from your country (oh
  286. well...   a *very* nice postcard!).  Send whatever kind of donation to
  287. the following address:
  288.  
  289.                            Giuseppe Vicari
  290.                              via Torni, 7
  291.                          I-21051 Arcisate VA
  292.                                 ITALIA
  293.  
  294.     Thanks in advance for your generosity.
  295.  
  296.  
  297. >>>>    Who I'd like to thank?
  298.  
  299.     I'd like to thank the following people:
  300.  
  301. Matteo Taveggia
  302.     for the revision and English translation of this manual.
  303.  
  304. Flavio Stanchina and Maurizio Frizzo
  305.     for their suggestions.
  306.  
  307. Maximilian Hantsch e Martin J. Laubach
  308.     for their superb program TrapDoor.
  309.  
  310.  
  311. >>>>    How to check out this is the original program?
  312.  
  313.     In  the  archive  there  is program called CheckFiles.  This is an
  314. useful  tool  to verify that the files in the archive are the original
  315. ones.  After you extracted the files from the archive, from inside the
  316. directory  where  such files are run CheckFiles (it is case-sensitive,
  317. so  type  it paying attention!):  it will automatically tell you which
  318. (if any) files had been altered.
  319.  
  320.  
  321. >>>>    End of the document
  322.